Return

Edit Resource: AvailPeriodicWindows

Format

SCHED / EditResource '<ResourceName>' AvailPeriodicWindows <# periodic definitions> <Frequency1> <Periodic1Start> <Periodic1Stop> <Epoch (custom only)> <Interval (custom only)> '<Period1Comment>' <# Inside Windows> <Per1Window1Start> <Per1Window1Duration> '<Per1Window1Comment>' ... <Per1WindowNStart> <Per1WindowNDuration> '<Per1WindowNComment>' ... PeriodicDefinitionN

The AvailPeriodicWindows attribute under EditResource defines the available or unavailable windows of a resource (depending on default availability). These windows occur on a regular basis, determined by a certain frequency, within a given time interval. When this command is sent, all previous periodic windows are deleted.

For more information on parameters, see the description of the Periodic Window Definition Form

Parameters

ParameterDescription
# Periodic DefinitionsAn integer value that, on its own, indicates the number of periodic definitions within the command.
FrequencyFrequency options should be entered on their own and the options are as follows:
  • Yearly
  • Monthly
  • Weekly
  • Daily
  • Hourly
  • Minutely
  • Custom
Period Start/StopThe format is YYYY/MM/DD_HH:MM:SS or YYYY/MM/DD_HH:MM:SS.fff
Epoch (custom frequency only)Epoch time is only used if the frequency option is "Custom", otherwise the parameter should not be included in the command. The parameter should be on its own and in the format -- YYY/MM/DD__HH:MM:SS or YYYY/MM/DD_HH:MM:SS.fff.
Interval (custom frequency only)Interval is only used if the frequency option is "Custom", otherwise the parameter should not be included in the command. The parameter should be on its own and entered in numeric second(millisecond fidelity).
Period CommentA string of text of the comment itself in single quotes. May be an empty string if no comment is desired.
# Inside WindowsAn integer value that is required and may be zero if there are no definitions within the window. If the parameter value is zero, PerNWindow parameters should not be included.
PerNWindowNOffset

The parameter value format is based on the format of the frequency:
Yearly: MM/DD_HH:MM:SS.fff (e.g. 11/12_10:04:05.100)
Monthly: DD_HH:MM:SS.fff (e.g. 12_10:04:05.100)

Weekly: DD_HH:MM:SS.fff (e.g. TU_10:04:05.100)
Daily: HH:MM:SS.fff (e.g. 10:04:05.100)
Hourly: MM:SS.fff (e.g. 04:05.100)
Minutely: SS.fff (e.g. 05.100)
Can also be a number in seconds (millisecond fidelity). The offset is always anchored at the top of the windows frequency. For example, an offset of 1 hour for a daily recurrence would be 1:00:00 of that day. The start of the period has no effect on the offset other than for custom definitions.

PerNWindowNDurationEnter as a number in seconds (millisecond fidelity).
PerNWindowNCommentA string of text in single quotes of the comment for the given inside window.

Examples

Everyday from 08:88:88 to 12:00:00 Ops Team will run 'Morning Shift' and from 13:00:00 to 17:00:00 will run 'Afternoon Shift'.

SCHED / EditResource 'Ops Team' AvailPeriodicWindows 1 Daily 2017/01/01_00:00:00 2017/01/03_00:00:00 '' 2 08:00:00 14400 'Morning Shift' 13:00:00 14400 'Afternoon Shift'